Crate sycamore_reactive

Reactive primitives for Sycamore.

Structs

BoundedScope

A reference to a reactive scope. This reference is Copy, allowing it to be copied into closures without any clones.

Modify

A mutable reference for modifying a Signal.

RcSignal

A signal that is not bound to a Scope.

ReadSignal

A read-only Signal.

ScopeDisposer

A handle that allows cleaning up a Scope.

Signal

A container of reactive state that can be updated and subscribed to.

SignalEmitter

A struct for managing subscriptions to signals.

Traits

AnyReadSignal

A trait that is implemented for all ReadSignals regardless of the type parameter.

Functions

create_child_scope

Create a child scope.

create_effect

Creates an effect on signals used inside the effect closure.

create_effect_scoped

Creates an effect on signals used inside the effect closure.

create_memo

Creates a memoized computation from some signals. The output is derived from all the signals that are used within the memo closure. If any of the tracked signals are updated, the memo is also updated.

create_rc_signal

Create a new RcSignal with the specified initial value.

create_rc_signal_from_rc

Create a new RcSignal with the specified initial value wrapped in a Rc.

create_reducer

An alternative to create_signal that uses a reducer to get the next value.

create_ref

Allocate a new arbitrary value under the current Scope. The allocated value lasts as long as the scope and cannot be used outside of the scope.

create_scope

Creates a reactive scope.

create_scope_immediate

Creates a reactive scope, runs the callback, and disposes the scope immediately.

create_selector

Creates a memoized value from some signals. Unlike create_memo, this function will not notify dependents of a change if the output is the same. That is why the output of the function must implement PartialEq.

create_selector_with

Creates a memoized value from some signals. Unlike create_memo, this function will not notify dependents of a change if the output is the same.

create_signal

Create a new Signal under the current Scope. The created signal lasts as long as the scope and cannot be used outside of the scope.

create_signal_from_rc

Create a new Signal under the current Scope but with an initial value wrapped in a Rc. This is useful to avoid having to clone a value that is already wrapped in a Rc when creating a new signal. Otherwise, this is identical to create_signal.

map_indexed

Function that maps a Vec to another Vec via a map function. The mapped Vec is lazy computed, meaning that it’s value will only be updated when requested. Modifications to the input Vec are diffed by index to prevent recomputing values that have not changed.

map_keyed

Function that maps a Vec to another Vec via a map function. The mapped Vec is lazy computed, meaning that it’s value will only be updated when requested. Modifications to the input Vec are diffed using keys to prevent recomputing values that have not changed.

on

A helper function for making it explicit to define dependencies for an effect.

on_cleanup

Adds a callback that is called when the scope is destroyed.

provide_context

Provides a context in the current Scope. The context can later be accessed by using use_context lower in the scope hierarchy.

provide_context_ref

Provides a context in the current Scope. The context can later be accessed by using use_context lower in the scope hierarchy.

scope_depth

Returns the current depth of the scope. If the scope is the root scope, returns 0.

try_use_context

Tries to get a context value of the given type. If no context with the right type found, returns None. For a panicking version, see use_context.

untrack

Run the passed closure inside an untracked dependency scope.

use_context

Gets a context value of the given type.

use_context_or_else

Gets a context value of the given type or computes it from a closure.

use_context_or_else_ref

Gets a context value of the given type or computes it from a closure.

use_scope_status

Returns a RcSignal that is true when the scope is still valid and false once it is disposed.

Type Definitions

Scope

A type-alias for BoundedScope where both lifetimes are the same.